GrapeCity.Xaml.CalcEngine
Evaluate(Object[]) Method


GrapeCity.CalcEngine.Functions Namespace > CalcCoupNumFunction Class > Evaluate Method : Evaluate(Object[]) Method

The args contains 3 - 4 items: settlement, maturity, frequency, [basis].

Settlement is the security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

Maturity is the security's maturity date. The maturity date is the date when the security expires.

Frequency is the number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.

Basis is the type of day count basis to use.

Returns the System.Int32 number of coupons payable between the settlement date and maturity date, rounded up to the nearest whole coupon.
Syntax
'Declaration
 
Public Overloads Overrides Function Evaluate( _
   ByVal args() As Object _
) As Object
'Usage
 
Dim instance As CalcCoupNumFunction
Dim args() As Object
Dim value As Object
 
value = instance.Evaluate(args)
public override object Evaluate( 
   object[] args
)

Parameters

args

The args contains 3 - 4 items: settlement, maturity, frequency, [basis].

Settlement is the security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

Maturity is the security's maturity date. The maturity date is the date when the security expires.

Frequency is the number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.

Basis is the type of day count basis to use.

Return Value

A System.Int32 value that indicates the evaluate result.
See Also

Reference

CalcCoupNumFunction Class
CalcCoupNumFunction Members
Overload List